home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / e / ddmoduls.lha / dd_Modules / dd_devices / dd_timenotify.doc next >
Text File  |  1995-05-05  |  2KB  |  87 lines
  1. dd_blackboxes/dd_timenotify
  2.  
  3. NAME
  4.  
  5.   dd_timenotify.m -- module for requesting timed events
  6.  
  7. AUTHOR
  8.  
  9.   Leon Woestenberg of Digital Disturbance (Email: leon@stack.urc.tue.nl)
  10.  
  11. REQUIREMENTS
  12.  
  13.   Requires the amigaguide.library v34 (or later) to be installed.
  14.  
  15. DESCRIPTION
  16.  
  17.   The dd_timenotify module adds functionality often required in a
  18.   multitasking environment: the need for timerequest events. Your program
  19.   can continue handling events, like user input, while an 'alarm clock'
  20.   is running asynchronously that signals your task when a certain time
  21.   has passed.
  22.  
  23. FEATURES
  24.  
  25.   Simple blackbox object for timerequest events. Instead of using AmigaDOS
  26.   Delay() or amiga.lib's TimeDelay(), which blocks your task for a certain
  27.   time, the methods understood by this object provide asynchronous
  28.   timerequest. Your task can continue processing events in this way.
  29.  
  30. METHODS
  31.  
  32.   new -- construct a class instance
  33.  
  34.     SYNOPSIS
  35.       instance.new()
  36.  
  37.     RESULT
  38.        Raises exceptions when construction failed.
  39.  
  40.   request -- request a time event
  41.  
  42.     SYNOPSIS
  43.       instance.request(seconds,microseconds)
  44.  
  45.     FUNCTION
  46.       Request a time event that will notify your task after a certain
  47.       period of time, by setting a task signal bit. If there's still a
  48.       time event pending, it will be replaced by the new one. To issue
  49.       multiple time events simultaneously, use an object for each of
  50.       these.
  51.  
  52.     INPUTS
  53.       seconds (LONG) -- Number of seconds before notification.
  54.       microseconds (LONG) -- Number of microseconds before notification.
  55.  
  56.     RESULT
  57.       Returns the signalmask your program should Wait() for.
  58.  
  59.    signalmask -- returns the signal to wait for
  60.  
  61.     SYNOPSIS
  62.       instance.signalmask()
  63.  
  64.     FUNCTION
  65.       Returns the signalmask your program should Wait() for.
  66.  
  67.     RESULT
  68.       A 32 bit mask indicating which signal is reserved for amigaguide
  69.       communication.
  70.  
  71.   end -- destruct a class instance
  72.  
  73.     SYNOPSIS
  74.       END instance
  75.  
  76.     FUNCTION
  77.       Destructs an object instance, aborts the outstanding timerequest.
  78.  
  79. TODO
  80.  
  81.   - Make the object handle multiple timerequests similarly.
  82.  
  83. SEE ALSO
  84.  
  85.   timer.device
  86.  
  87.